Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add log-level to launcher + fix trace debug #1757

Merged
merged 3 commits into from
Jan 24, 2024
Merged

Add log-level to launcher + fix trace debug #1757

merged 3 commits into from
Jan 24, 2024
+19 −2

Conversation

otherview
Copy link
Contributor

Why this change is needed

https://github.com/ten-protocol/ten-internal/issues/2799

As per title.

What changes were made as part of this PR

Please provide a high level list of the changes made

PR checks pre-merging

Please indicate below by ticking the checkbox that you have read and performed the required
PR checks

  • PR checks reviewed and performed

@otherview otherview requested a review from moraygrieve January 24, 2024 13:56
@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jan 24, 2024 •
edited
Loading

Walkthrough

The codebase has undergone a series of changes focused on logging functionality. The ingestionType parameter was removed from a log message, possibly altering its meaning and how logs are captured. Meanwhile, new features were introduced to manage log levels, including a logLevel field in configuration structures and corresponding CLI flag parsing. These adjustments allow for dynamic log level settings when launching a testnet, providing users with more control over the verbosity of logging.

Changes

Files Change Summary
go/enclave/components/block_processor.go Removed ingestionType from log message
testnet/launcher/cmd/cli.go, testnet/launcher/config.go Added logLevel field to structs and updated functions for parsing and setting log level
testnet/launcher/cmd/cli_flags.go, testnet/launcher/cmd/main.go Introduced logLevelFlag and included it in the CLI for setting log level when starting the testnet
testnet/launcher/.../docker.go Modified Start method to use logLevel from config instead of a hard-coded value

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

coderabbitai[bot]
coderabbitai bot reviewed Jan 24, 2024
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 2019eac and 53e3e18.
Files selected for processing (6)
  • go/enclave/components/block_processor.go (1 hunks)
  • testnet/launcher/cmd/cli.go (3 hunks)
  • testnet/launcher/cmd/cli_flags.go (2 hunks)
  • testnet/launcher/cmd/main.go (1 hunks)
  • testnet/launcher/config.go (2 hunks)
  • testnet/launcher/docker.go (2 hunks)
Additional comments: 11
testnet/launcher/cmd/main.go (1)
  • 23-23: The addition of the logLevel configuration option to the launcher is correctly implemented.
testnet/launcher/cmd/cli_flags.go (2)
  • 12-12: The new logLevelFlag constant is correctly defined.
  • 26-26: The description for the logLevelFlag in the getFlagUsageMap function is added and matches the intended functionality.
testnet/launcher/config.go (2)
  • 19-19: The logLevel field is correctly added to the Config struct.
  • 74-78: The WithLogLevel function is correctly implemented to set the logLevel field in the Config struct.
testnet/launcher/cmd/cli.go (3)
  • 16-16: The logLevel field is correctly added to the TestnetConfigCLI struct.
  • 31-31: The parsing of the logLevel flag from the command line is correctly implemented.
  • 41-41: The assignment of the parsed logLevel to the TestnetConfigCLI struct is correct.
go/enclave/components/block_processor.go (1)
  • 118-118: The removal of the "ingestionType" log parameter from the "Block inserted successfully" log message is noted. Ensure that this change is reflected in any documentation or monitoring tools that rely on this log parameter.
testnet/launcher/docker.go (2)
  • 65-65: The Start method of the Testnet type now correctly uses the logLevel from the configuration.
  • 105-105: The logLevel is also correctly used in the configuration of the validator node.

BedrockSquirrel
BedrockSquirrel reviewed Jan 24, 2024
View reviewed changes
Copy link
Collaborator

@BedrockSquirrel BedrockSquirrel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM but couple comments

go/enclave/components/block_processor.go Outdated Show resolved Hide resolved
testnet/launcher/cmd/cli.go Outdated Show resolved Hide resolved
coderabbitai[bot]
coderabbitai bot reviewed Jan 24, 2024
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 53e3e18 and 482a02d.
Files selected for processing (1)
  • testnet/launcher/cmd/cli.go (3 hunks)
Files skipped from review as they are similar to previous changes (1)
  • testnet/launcher/cmd/cli.go

coderabbitai[bot]
coderabbitai bot reviewed Jan 24, 2024
View reviewed changes
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 482a02d and 1dfae32.
Files selected for processing (1)
  • go/common/types.go (1 hunks)
Additional comments: 1
go/common/types.go (1)
  • 187-189: The addition of a nil check in the String method of the ChainFork type is a good defensive programming practice to prevent potential nil pointer dereferences.

BedrockSquirrel
BedrockSquirrel approved these changes Jan 24, 2024
View reviewed changes
Copy link
Collaborator

@BedrockSquirrel BedrockSquirrel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@otherview otherview merged commit 9c81010 into main Jan 24, 2024
2 checks passed
@otherview otherview deleted the pedro/log_level_cli branch January 24, 2024 15:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@BedrockSquirrel BedrockSquirrel BedrockSquirrel approved these changes

@moraygrieve moraygrieve Awaiting requested review from moraygrieve

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@otherview @BedrockSquirrel